org.eclipse.vtp.framework.interactions.core.commands
Class OutputMessageCommand

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand
      org.eclipse.vtp.framework.interactions.core.commands.OutputMessageCommand

All Implemented Interfaces:

ICommand

public final class OutputMessageCommand
extends ConversationCommand

A command that renders output to the user.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

INPUT_TYPE_CUSTOM, INPUT_TYPE_FILE, OUTPUT_TYPE_FILE, OUTPUT_TYPE_TEXT

Constructor Summary

OutputMessageCommand()
Creates a new OutputMessageCommand.

Method Summary

void	addFileOutput(java.lang.String path) Adds a file output item to this output message.
void	addTextOutput(java.lang.String text) Adds a text output item to this output message.
java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
int	getOutputCount() Returns the number of output elements configured in this output message.
int	getOutputType(int outputIndex) Returns the type of the output at the specified index.
java.lang.String	getOutputValue(int outputIndex) Returns the value of the output at the specified index.
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the interaction.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the process resumes.
java.lang.String[]	getPropertyNames() Returns the names of the properties of the interaction.
java.lang.String	getPropertyValue(java.lang.String name) Returns the value of a property of the interaction.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
void	insertFileOutput(int outputIndex, java.lang.String path) Adds a file output item to this output message at the specified index.
void	insertTextOutput(int outputIndex, java.lang.String text) Adds a text output item to this output message at the specified index.
void	removeOutput(int outputIndex) Removes the output item in this output message at the specified index.
void	setFileOutput(int outputIndex, java.lang.String path) Sets the file output item in this output message at the specified index.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setPropertyValue(java.lang.String name, java.lang.String value) Configures a property of the interaction.
void	setTextOutput(int outputIndex, java.lang.String text) Sets the text output item in this output message at the specified index.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputMessageCommand

public OutputMessageCommand()

Creates a new OutputMessageCommand.

Method Detail

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns the names of the properties of the interaction.

Returns:

The names of the properties of the interaction.

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Returns the value of a property of the interaction.

Parameters:

name - The name of the property to be set.

Returns:

The value that the specified property will be set to.

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

Configures a property of the interaction.

Parameters:

name - The name of the property to set.

value - The value to set the property to.

getOutputCount

public int getOutputCount()

Returns the number of output elements configured in this output message.

Returns:

The number of output elements configured in this output message.

getOutputType

public int getOutputType(int outputIndex)

Returns the type of the output at the specified index.

Parameters:

outputIndex - The index to check.

Returns:

The type of the output at the specified index.

getOutputValue

public java.lang.String getOutputValue(int outputIndex)

Returns the value of the output at the specified index.

Parameters:

outputIndex - The index to check.

Returns:

The value of the output at the specified index.

addFileOutput

public void addFileOutput(java.lang.String path)

Adds a file output item to this output message.

Parameters:

path - The path of the file to render.

addTextOutput

public void addTextOutput(java.lang.String text)

Adds a text output item to this output message.

Parameters:

text - The text to render.

insertFileOutput

public void insertFileOutput(int outputIndex,
                             java.lang.String path)

Adds a file output item to this output message at the specified index.

Parameters:

outputIndex - The index to insert at.

path - The path of the file to render.

insertTextOutput

public void insertTextOutput(int outputIndex,
                             java.lang.String text)

Adds a text output item to this output message at the specified index.

Parameters:

outputIndex - The index to insert at.

text - The text to render.

setFileOutput

public void setFileOutput(int outputIndex,
                          java.lang.String path)

Sets the file output item in this output message at the specified index.

Parameters:

outputIndex - The index to set at.

path - The path of the file to render.

setTextOutput

public void setTextOutput(int outputIndex,
                          java.lang.String text)

Sets the text output item in this output message at the specified index.

Parameters:

outputIndex - The index to set at.

text - The text to render.

removeOutput

public void removeOutput(int outputIndex)

Removes the output item in this output message at the specified index.

Parameters:

outputIndex - The index to remove at.

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the interaction.

Returns:

The names of the parameters that will be returned from the interaction.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.